useListCollectiblesPaginated

The useListCollectiblesPaginated hook efficiently retrieves and manages current listings and offers from your Marketplace, making it ideal for displaying paginated NFTs within a collection.

import { OrderSide } from '@0xsequence/marketplace-sdk';
import { useListCollectiblesPaginated } from '@0xsequence/marketplace-sdk/react';

const chainId = 137;
const searchText = "";
const enabled = true;
const includeEmpty = true;
const properties = [];
const pageSize = 30;
const currentPage = 1;
const collectionAddress = "0x0e5566a108e617baedbebb44e3fcc7bf03e3a839";

## Into your React component:

const {
    data: collectiblesResponse,
    isLoading: collectiblesLoading,
} = useListCollectiblesPaginated({
  chainId: String(chainId),
  collectionAddress,
  side: OrderSide.listing,
  filter: {
    // # Optional filters
    includeEmpty,
    searchText,
    properties,
  },
  page: {
    page: currentPage,
    pageSize,
  },
  query: {
    page: currentPage,
    pageSize,
    enabled,
  },
});

const collectiblesList = collectiblesResponse?.collectibles ?? [];

return (
  <div>
    {collectiblesList?.map((collectible) => (
      // Your Collectibles component
    ))}
  </div>
);

useListCollectiblesPaginated details

* params

Show child attributes

interface UseListCollectiblesPaginatedArgs {
  chainId: string;
  side: OrderSide;
  collectionAddress: `0x${string}`;
  page?: {
    page: number;
    pageSize: number;
    sort?: {
      order: SortOrder$1;
      column: string;
    }[];
    more?: boolean;
  };
  filter?: {
    includeEmpty: boolean;
    searchText?: string;
    properties?: {
      type: PropertyType;
      name: string;
      values?: any[];
      max?: number;
      min?: number;
    }[];
    marketplaces?: MarketplaceKind[];
    inAccounts?: string[];
    notInAccounts?: string[];
    ordersCreatedBy?: string[];
    ordersNotCreatedBy?: string[];
  };
  query: {
    page: number;
    pageSize: number;
    enabled?: boolean;
  };
}

* return properties

Show child attributes

data · ListCollectiblesReturn

Contains the collectible orders data.

data.collectibles · CollectibleOrder[]

List of collectible orders.

isLoading · boolean

Indicates whether the data is currently loading.